home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 September / macformat-028.iso / mac / Shareware in MacFormat / MacFolklore 1.0 / Documentation / How to change the questions < prev    next >
Encoding:
Text File  |  1995-04-19  |  6.7 KB  |  158 lines  |  [TEXT/R*ch]
  1. HOW TO ADD QUESTIONS TO MACFOLKLORE
  2. -----------------------------------
  3. Note: This document, Grade A, and MacFolklore are all (c)1995, by Scott J.
  4. Kleper. All Rights Reserved.
  5.  
  6. _I really like MacFolklore and I'd like more questions. What should I do?_
  7.  
  8. Well, the easiest way to get more questions is to register. If you send me
  9. $5, I'll send you back a disk with the registered version of MacFolklore
  10. and 100 bonus questions (in addition to the 50 that come with the shareware
  11. version). 
  12.  
  13.  
  14. _I don't want to do that. Is there any other way?_
  15.  
  16. Yes. MacFolklore was written using the Grade A testing engine (also
  17. written by me). This engine uses a text file to quiz the user. The file,
  18. which must be in the same folder as the program and named "questions",
  19. can be changed and changes will show up in MacFolklore. If you want
  20. to change this file, please read this document thoroughly first.
  21.  
  22.  
  23. _I want to use MacFolklore to test me on something totally different. Can
  24. I change the file to do that?_
  25.  
  26. Sure! I'd love to hear what you've done with it. I'm developing another
  27. program called "Grade A" that's meant more for educational testing, but
  28. MacFolklore can be used for such purposes in the mean time. I've used
  29. betas of Grade A to study for Spanish tests, vocabulary tests, and other
  30. school subjects.
  31.  
  32.  
  33. _Okay, let's do it. How do I get started?_
  34.  
  35. The first thing to do is make a backup copy of the questions file. You
  36. must realize that when you change the questions file, you are changing
  37. MacFolklore. Therefore, you may not redistribute MacFolklore with a
  38. modified quiz file. If you want the rest of the world to be able to 
  39. use your questions, however, you may distribute them separately. At the
  40. end of this document are specific instructions for doing that. You
  41. must follow these guidelines if you are going to redistribute your 
  42. questions file.
  43.  
  44. You can explore the questions file yourself to see how things are done.
  45. It's really pretty simple. The first few lines are "comment" lines. You
  46. can use this space for whatever you want in your file. If you want,
  47. you can put a copyright here. You can use up as many lines as you want.
  48.  
  49. After that, leave a blank line. This is how MacFolklore is able to tell
  50. when the comments end and when the quiz begins.
  51.  
  52. The first line after the blank line is the first question. The questions
  53. should be as short as possible to ensure that they fit. The next line
  54. after the question is the answer. It must be a numeral from one to 
  55. three. This tells MacFolklore which of the following choices is the 
  56. correct answer.
  57.  
  58. After the line with the answer, put the three choices, each on their
  59. own line. Remember that these choices have to fit inside buttons of
  60. set size, so try to keep them as short as possible.
  61.  
  62. The next line will be the next question. There are no blank lines
  63. between questions! You can see from examining the questions file that
  64. comes with MacFolklore that questions follow right along.
  65.  
  66.  
  67. _Does the order I list the choices matter?_
  68.  
  69. Yes. Future versions of the Grade A testing engine will automatically
  70. randomize the choice order so you can just memorize the answers. This
  71. version does not. The order you put them is the order they will show up
  72. on the quiz.
  73.  
  74.  
  75. _What if I make a mistake in the questions file?_
  76.  
  77. No big deal. For some mistakes, MacFolklore will give an error saying
  78. that there's a problem with the questions file. For others, it may
  79. give a memory error. Either way, MacFolklore will quit without any
  80. major problems, and you can go inspect your file. Here's a quick hint:
  81. each group of question,answer,choices has to total five lines (one
  82. for the question, one for the answer, and three for the choices). So
  83. if you use an editor that tells you how many lines the file is, you
  84. can tell if your file has a problem. Take the total number of lines
  85. and subtract the number of comment lines including the blank line. If
  86. this number is a multiple of 5, you're probably okay. Also, if you
  87. put a letter or number greater than 3 for the correct answer, 
  88. MacFolklore will assume you meant three. For readability purposes, I
  89. suggest you just use 3.
  90.  
  91.  
  92. _How long can the file be?_
  93.  
  94. MacFolklore will stop reading questions after number 500. In theory,
  95. it should be able to read as many as memory permits. MacFolklore has 
  96. been tested with up to 150 questions (the number supplied in the 
  97. registered version). You should be able to use many more than that
  98. without a problem. If MacFolklore runs out of memory while loading 
  99. in the file, it will automatically quit without giving an error. If
  100. this happens, try increasing the memory partition or getting rid
  101. of some questions. Also, you should realize that MacFolklore has to
  102. read in all the questions, sort them, and randomize them. This could
  103. take a while on slower Macs if you have more than 150 questions.
  104.  
  105.  
  106. _How can I distribute my questions?_
  107.  
  108. That all depends on how they will be used. If you just want to supply
  109. additional questions for people to use, there are only two restrictions.
  110. First, you must not distribute it with MacFolklore. It must be a 
  111. separate file distributed separately. Second, you must include the
  112. following disclaimer within your comment portion of the file:
  113.  
  114. "These questions were written by a separate author and are not part
  115. of the MacFolklore package. Scott J. Kleper, the author of
  116. MacFolklore is in no way responsible for these questions or their
  117. accuracy. To receive 150 questions about Macintosh history for use
  118. with MacFolklore from the author, send $5 to Scott J. Kleper,
  119. 134 Caversham Woods, Pittsford, NY  14534. MacFolklore is (c)1995,
  120. by Scott J. Kleper."
  121.  
  122. I know that's a mouthful, but most of your users will never see it
  123. anyways! 
  124.  
  125. If you're going to use MacFolklore as an engine for some other
  126. testing purposes (educational or otherwise), I suggest that you
  127. contact me first. Basically, if your use is non-commercial, I'll
  128. allow you to use the MacFolklore program, unmodified except for
  129. the questions file, at no charge. If it's for a company or any
  130. sort of for-profit organization, you must contact me to work out
  131. a licensing deal. In most cases, this will be about $20. Either
  132. way, you must include the above disclaimer in your comments 
  133. section of the questions file.
  134.  
  135.  
  136. _Are you going to write any more questions files?_
  137.  
  138. Yes. As I said above, when you register, you get 100 bonus
  139. questions. I may also make some questions files of specific 
  140. topics, like Macintosh programming, or the Apple ][. I haven't
  141. decided when or how I will do this yet. The best way to find
  142. these files is to check the MacFolklore web page:
  143.  
  144. http://htc.rit.edu/folklore.html
  145.  
  146.  
  147. _How can I contact you?_
  148.  
  149. I'd enjoy hearing how you have customized MacFolklore. Please
  150. drop me a note if you've done something interesting with it
  151. or if you have any questions.
  152.  
  153. Scott J. Kleper
  154. 134 Caversham Woods
  155. Pittsford, NY  14534
  156.  
  157. sjked@rit.edu
  158.